<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.configuration.tree;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import java.util.Collections;<a name="line.19"></a>
<FONT color="green">020</FONT>    import java.util.LinkedList;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.util.List;<a name="line.21"></a>
<FONT color="green">022</FONT>    <a name="line.22"></a>
<FONT color="green">023</FONT>    /**<a name="line.23"></a>
<FONT color="green">024</FONT>     * &lt;p&gt;<a name="line.24"></a>
<FONT color="green">025</FONT>     * A simple data class used by {@link ExpressionEngine} to store<a name="line.25"></a>
<FONT color="green">026</FONT>     * the results of the {@code prepareAdd()} operation.<a name="line.26"></a>
<FONT color="green">027</FONT>     * &lt;/p&gt;<a name="line.27"></a>
<FONT color="green">028</FONT>     * &lt;p&gt;<a name="line.28"></a>
<FONT color="green">029</FONT>     * If a new property is to be added to a configuration, the affected<a name="line.29"></a>
<FONT color="green">030</FONT>     * {@code Configuration} object must know, where in its hierarchy of<a name="line.30"></a>
<FONT color="green">031</FONT>     * configuration nodes new elements have to be added. This information is<a name="line.31"></a>
<FONT color="green">032</FONT>     * obtained by an {@code ExpressionEngine} object that interprets the key<a name="line.32"></a>
<FONT color="green">033</FONT>     * of the new property. This expression engine will pack all information<a name="line.33"></a>
<FONT color="green">034</FONT>     * necessary for the configuration to perform the add operation in an instance<a name="line.34"></a>
<FONT color="green">035</FONT>     * of this class.<a name="line.35"></a>
<FONT color="green">036</FONT>     * &lt;/p&gt;<a name="line.36"></a>
<FONT color="green">037</FONT>     * &lt;p&gt;<a name="line.37"></a>
<FONT color="green">038</FONT>     * Information managed by this class contains:<a name="line.38"></a>
<FONT color="green">039</FONT>     * &lt;ul&gt;<a name="line.39"></a>
<FONT color="green">040</FONT>     * &lt;li&gt;the configuration node, to which new elements must be added&lt;/li&gt;<a name="line.40"></a>
<FONT color="green">041</FONT>     * &lt;li&gt;the name of the new node&lt;/li&gt;<a name="line.41"></a>
<FONT color="green">042</FONT>     * &lt;li&gt;whether the new node is a child node or an attribute node&lt;/li&gt;<a name="line.42"></a>
<FONT color="green">043</FONT>     * &lt;li&gt;if a whole branch is to be added at once, the names of all nodes between<a name="line.43"></a>
<FONT color="green">044</FONT>     * the parent node (the target of the add operation) and the new node&lt;/li&gt;<a name="line.44"></a>
<FONT color="green">045</FONT>     * &lt;/ul&gt;<a name="line.45"></a>
<FONT color="green">046</FONT>     * &lt;/p&gt;<a name="line.46"></a>
<FONT color="green">047</FONT>     *<a name="line.47"></a>
<FONT color="green">048</FONT>     * @since 1.3<a name="line.48"></a>
<FONT color="green">049</FONT>     * @author &lt;a<a name="line.49"></a>
<FONT color="green">050</FONT>     * href="http://commons.apache.org/configuration/team-list.html"&gt;Commons<a name="line.50"></a>
<FONT color="green">051</FONT>     * Configuration team&lt;/a&gt;<a name="line.51"></a>
<FONT color="green">052</FONT>     * @version $Id: NodeAddData.java 1234988 2012-01-23 21:12:15Z oheger $<a name="line.52"></a>
<FONT color="green">053</FONT>     */<a name="line.53"></a>
<FONT color="green">054</FONT>    public class NodeAddData<a name="line.54"></a>
<FONT color="green">055</FONT>    {<a name="line.55"></a>
<FONT color="green">056</FONT>        /** Stores the parent node of the add operation. */<a name="line.56"></a>
<FONT color="green">057</FONT>        private ConfigurationNode parent;<a name="line.57"></a>
<FONT color="green">058</FONT>    <a name="line.58"></a>
<FONT color="green">059</FONT>        /**<a name="line.59"></a>
<FONT color="green">060</FONT>         * Stores a list with nodes that are on the path between the parent node and<a name="line.60"></a>
<FONT color="green">061</FONT>         * the new node.<a name="line.61"></a>
<FONT color="green">062</FONT>         */<a name="line.62"></a>
<FONT color="green">063</FONT>        private List&lt;String&gt; pathNodes;<a name="line.63"></a>
<FONT color="green">064</FONT>    <a name="line.64"></a>
<FONT color="green">065</FONT>        /** Stores the name of the new node. */<a name="line.65"></a>
<FONT color="green">066</FONT>        private String newNodeName;<a name="line.66"></a>
<FONT color="green">067</FONT>    <a name="line.67"></a>
<FONT color="green">068</FONT>        /** Stores the attribute flag. */<a name="line.68"></a>
<FONT color="green">069</FONT>        private boolean attribute;<a name="line.69"></a>
<FONT color="green">070</FONT>    <a name="line.70"></a>
<FONT color="green">071</FONT>        /**<a name="line.71"></a>
<FONT color="green">072</FONT>         * Creates a new, uninitialized instance of {@code NodeAddData}.<a name="line.72"></a>
<FONT color="green">073</FONT>         */<a name="line.73"></a>
<FONT color="green">074</FONT>        public NodeAddData()<a name="line.74"></a>
<FONT color="green">075</FONT>        {<a name="line.75"></a>
<FONT color="green">076</FONT>            this(null, null);<a name="line.76"></a>
<FONT color="green">077</FONT>        }<a name="line.77"></a>
<FONT color="green">078</FONT>    <a name="line.78"></a>
<FONT color="green">079</FONT>        /**<a name="line.79"></a>
<FONT color="green">080</FONT>         * Creates a new instance of {@code NodeAddData} and sets the most<a name="line.80"></a>
<FONT color="green">081</FONT>         * important data fields.<a name="line.81"></a>
<FONT color="green">082</FONT>         *<a name="line.82"></a>
<FONT color="green">083</FONT>         * @param parent the parent node<a name="line.83"></a>
<FONT color="green">084</FONT>         * @param nodeName the name of the new node<a name="line.84"></a>
<FONT color="green">085</FONT>         */<a name="line.85"></a>
<FONT color="green">086</FONT>        public NodeAddData(ConfigurationNode parent, String nodeName)<a name="line.86"></a>
<FONT color="green">087</FONT>        {<a name="line.87"></a>
<FONT color="green">088</FONT>            setParent(parent);<a name="line.88"></a>
<FONT color="green">089</FONT>            setNewNodeName(nodeName);<a name="line.89"></a>
<FONT color="green">090</FONT>        }<a name="line.90"></a>
<FONT color="green">091</FONT>    <a name="line.91"></a>
<FONT color="green">092</FONT>        /**<a name="line.92"></a>
<FONT color="green">093</FONT>         * Returns a flag if the new node to be added is an attribute.<a name="line.93"></a>
<FONT color="green">094</FONT>         *<a name="line.94"></a>
<FONT color="green">095</FONT>         * @return &lt;b&gt;true&lt;/b&gt; for an attribute node, &lt;b&gt;false&lt;/b&gt; for a child<a name="line.95"></a>
<FONT color="green">096</FONT>         * node<a name="line.96"></a>
<FONT color="green">097</FONT>         */<a name="line.97"></a>
<FONT color="green">098</FONT>        public boolean isAttribute()<a name="line.98"></a>
<FONT color="green">099</FONT>        {<a name="line.99"></a>
<FONT color="green">100</FONT>            return attribute;<a name="line.100"></a>
<FONT color="green">101</FONT>        }<a name="line.101"></a>
<FONT color="green">102</FONT>    <a name="line.102"></a>
<FONT color="green">103</FONT>        /**<a name="line.103"></a>
<FONT color="green">104</FONT>         * Sets the attribute flag. This flag determines whether an attribute or a<a name="line.104"></a>
<FONT color="green">105</FONT>         * child node will be added.<a name="line.105"></a>
<FONT color="green">106</FONT>         *<a name="line.106"></a>
<FONT color="green">107</FONT>         * @param attribute the attribute flag<a name="line.107"></a>
<FONT color="green">108</FONT>         */<a name="line.108"></a>
<FONT color="green">109</FONT>        public void setAttribute(boolean attribute)<a name="line.109"></a>
<FONT color="green">110</FONT>        {<a name="line.110"></a>
<FONT color="green">111</FONT>            this.attribute = attribute;<a name="line.111"></a>
<FONT color="green">112</FONT>        }<a name="line.112"></a>
<FONT color="green">113</FONT>    <a name="line.113"></a>
<FONT color="green">114</FONT>        /**<a name="line.114"></a>
<FONT color="green">115</FONT>         * Returns the name of the new node.<a name="line.115"></a>
<FONT color="green">116</FONT>         *<a name="line.116"></a>
<FONT color="green">117</FONT>         * @return the new node's name<a name="line.117"></a>
<FONT color="green">118</FONT>         */<a name="line.118"></a>
<FONT color="green">119</FONT>        public String getNewNodeName()<a name="line.119"></a>
<FONT color="green">120</FONT>        {<a name="line.120"></a>
<FONT color="green">121</FONT>            return newNodeName;<a name="line.121"></a>
<FONT color="green">122</FONT>        }<a name="line.122"></a>
<FONT color="green">123</FONT>    <a name="line.123"></a>
<FONT color="green">124</FONT>        /**<a name="line.124"></a>
<FONT color="green">125</FONT>         * Sets the name of the new node. A node with this name will be added to the<a name="line.125"></a>
<FONT color="green">126</FONT>         * configuration's node hierarchy.<a name="line.126"></a>
<FONT color="green">127</FONT>         *<a name="line.127"></a>
<FONT color="green">128</FONT>         * @param newNodeName the name of the new node<a name="line.128"></a>
<FONT color="green">129</FONT>         */<a name="line.129"></a>
<FONT color="green">130</FONT>        public void setNewNodeName(String newNodeName)<a name="line.130"></a>
<FONT color="green">131</FONT>        {<a name="line.131"></a>
<FONT color="green">132</FONT>            this.newNodeName = newNodeName;<a name="line.132"></a>
<FONT color="green">133</FONT>        }<a name="line.133"></a>
<FONT color="green">134</FONT>    <a name="line.134"></a>
<FONT color="green">135</FONT>        /**<a name="line.135"></a>
<FONT color="green">136</FONT>         * Returns the parent node.<a name="line.136"></a>
<FONT color="green">137</FONT>         *<a name="line.137"></a>
<FONT color="green">138</FONT>         * @return the parent node<a name="line.138"></a>
<FONT color="green">139</FONT>         */<a name="line.139"></a>
<FONT color="green">140</FONT>        public ConfigurationNode getParent()<a name="line.140"></a>
<FONT color="green">141</FONT>        {<a name="line.141"></a>
<FONT color="green">142</FONT>            return parent;<a name="line.142"></a>
<FONT color="green">143</FONT>        }<a name="line.143"></a>
<FONT color="green">144</FONT>    <a name="line.144"></a>
<FONT color="green">145</FONT>        /**<a name="line.145"></a>
<FONT color="green">146</FONT>         * Sets the parent node. New nodes will be added to this node.<a name="line.146"></a>
<FONT color="green">147</FONT>         *<a name="line.147"></a>
<FONT color="green">148</FONT>         * @param parent the parent node<a name="line.148"></a>
<FONT color="green">149</FONT>         */<a name="line.149"></a>
<FONT color="green">150</FONT>        public void setParent(ConfigurationNode parent)<a name="line.150"></a>
<FONT color="green">151</FONT>        {<a name="line.151"></a>
<FONT color="green">152</FONT>            this.parent = parent;<a name="line.152"></a>
<FONT color="green">153</FONT>        }<a name="line.153"></a>
<FONT color="green">154</FONT>    <a name="line.154"></a>
<FONT color="green">155</FONT>        /**<a name="line.155"></a>
<FONT color="green">156</FONT>         * Returns a list with further nodes that must be added. This is needed if a<a name="line.156"></a>
<FONT color="green">157</FONT>         * complete branch is to be added at once. For instance imagine that there<a name="line.157"></a>
<FONT color="green">158</FONT>         * exists only a node {@code database}. Now the key<a name="line.158"></a>
<FONT color="green">159</FONT>         * {@code database.connection.settings.username} (assuming the syntax<a name="line.159"></a>
<FONT color="green">160</FONT>         * of the default expression engine) is to be added. Then<a name="line.160"></a>
<FONT color="green">161</FONT>         * {@code username} is the name of the new node, but the nodes<a name="line.161"></a>
<FONT color="green">162</FONT>         * {@code connection} and {@code settings} must be added to<a name="line.162"></a>
<FONT color="green">163</FONT>         * the parent node first. In this example these names would be returned by<a name="line.163"></a>
<FONT color="green">164</FONT>         * this method.<a name="line.164"></a>
<FONT color="green">165</FONT>         *<a name="line.165"></a>
<FONT color="green">166</FONT>         * @return a list with the names of nodes that must be added as parents of<a name="line.166"></a>
<FONT color="green">167</FONT>         * the new node (never &lt;b&gt;null&lt;/b&gt;)<a name="line.167"></a>
<FONT color="green">168</FONT>         */<a name="line.168"></a>
<FONT color="green">169</FONT>        public List&lt;String&gt; getPathNodes()<a name="line.169"></a>
<FONT color="green">170</FONT>        {<a name="line.170"></a>
<FONT color="green">171</FONT>            if (pathNodes != null)<a name="line.171"></a>
<FONT color="green">172</FONT>            {<a name="line.172"></a>
<FONT color="green">173</FONT>                return Collections.unmodifiableList(pathNodes);<a name="line.173"></a>
<FONT color="green">174</FONT>            }<a name="line.174"></a>
<FONT color="green">175</FONT>            else<a name="line.175"></a>
<FONT color="green">176</FONT>            {<a name="line.176"></a>
<FONT color="green">177</FONT>                return Collections.emptyList();<a name="line.177"></a>
<FONT color="green">178</FONT>            }<a name="line.178"></a>
<FONT color="green">179</FONT>        }<a name="line.179"></a>
<FONT color="green">180</FONT>    <a name="line.180"></a>
<FONT color="green">181</FONT>        /**<a name="line.181"></a>
<FONT color="green">182</FONT>         * Adds the name of a path node. With this method an additional node to be<a name="line.182"></a>
<FONT color="green">183</FONT>         * added can be defined.<a name="line.183"></a>
<FONT color="green">184</FONT>         *<a name="line.184"></a>
<FONT color="green">185</FONT>         * @param nodeName the name of the node<a name="line.185"></a>
<FONT color="green">186</FONT>         * @see #getPathNodes()<a name="line.186"></a>
<FONT color="green">187</FONT>         */<a name="line.187"></a>
<FONT color="green">188</FONT>        public void addPathNode(String nodeName)<a name="line.188"></a>
<FONT color="green">189</FONT>        {<a name="line.189"></a>
<FONT color="green">190</FONT>            if (pathNodes == null)<a name="line.190"></a>
<FONT color="green">191</FONT>            {<a name="line.191"></a>
<FONT color="green">192</FONT>                pathNodes = new LinkedList&lt;String&gt;();<a name="line.192"></a>
<FONT color="green">193</FONT>            }<a name="line.193"></a>
<FONT color="green">194</FONT>            pathNodes.add(nodeName);<a name="line.194"></a>
<FONT color="green">195</FONT>        }<a name="line.195"></a>
<FONT color="green">196</FONT>    }<a name="line.196"></a>




























































</PRE>
</BODY>
</HTML>
